FrameLib  0.7
DSP processing with frames of arbitrary timing and length
FrameLib_Block Class Referenceabstract

#include <FrameLib_Object.h>

Inheritance diagram for FrameLib_Block:
FrameLib_Object< FrameLib_Block > FrameLib_Queueable< FrameLib_Block > FrameLib_DSP FrameLib_AudioInput FrameLib_AudioOutput FrameLib_Processor FrameLib_Scheduler

Public Member Functions

 FrameLib_Block (ObjectType type, FrameLib_Context context, void *owner)
 
virtual ~FrameLib_Block ()
 
virtual void setChannel (unsigned long chan)
 
virtual unsigned long getNumInputObjects (unsigned long blockIdx)=0
 
virtual class FrameLib_DSPgetInputObject (unsigned long blockIdx, unsigned long idx)=0
 
virtual unsigned long getInputObjectIdx (unsigned long blockIdx, unsigned long idx)=0
 
virtual class FrameLib_DSPgetOutputObject (unsigned long blockIdx)=0
 
virtual unsigned long getOutputObjectIdx (unsigned long blockIdx)=0
 
virtual unsigned long getNumOrderingConnectionObjects ()=0
 
virtual class FrameLib_DSPgetOrderingConnectionObject (unsigned long idx)=0
 
- Public Member Functions inherited from FrameLib_Object< FrameLib_Block >
 FrameLib_Object (ObjectType type, FrameLib_Context context, void *owner, FrameLib_Block *parent)
 
virtual ~FrameLib_Object ()
 
ObjectType getType () const
 
FrameLib_Context getContext () const
 
void * getOwner () const
 
unsigned long getNumIns () const
 
unsigned long getNumOuts () const
 
unsigned long getNumAudioIns () const
 
unsigned long getNumAudioOuts () const
 
unsigned long getNumAudioChans () const
 
virtual void setFixedInput (unsigned long idx, double *input, unsigned long size)=0
 
virtual void blockUpdate (double **ins, double **outs, unsigned long blockSize)=0
 
virtual void reset (double samplingRate, unsigned long maxBlockSize)=0
 
virtual std::string objectInfo (bool verbose=false)
 
virtual std::string inputInfo (unsigned long idx, bool verbose=false)
 
virtual std::string outputInfo (unsigned long idx, bool verbose=false)
 
virtual std::string audioInfo (unsigned long idx, bool verbose=false)
 
virtual FrameType inputType (unsigned long idx) const=0
 
virtual FrameType outputType (unsigned long idx) const=0
 
virtual const FrameLib_ParametersgetParameters () const
 
ConnectionResult addConnection (FrameLib_Block *object, unsigned long outIdx, unsigned long inIdx)
 
void deleteConnection (unsigned long inIdx)
 
ConnectionResult addOrderingConnection (FrameLib_Block *object, unsigned long outIdx)
 
void deleteOrderingConnection (FrameLib_Block *object, unsigned long outIdx)
 
void clearOrderingConnections ()
 
void clearConnections ()
 
bool isConnected (unsigned long inIdx) const
 
virtual void autoOrderingConnections ()=0
 
virtual void clearAutoOrderingConnections ()=0
 
FrameLib_BlockgetConnection (unsigned long idx) const
 
unsigned long getConnectionIdx (unsigned long idx) const
 
bool supportsOrderingConnections () const
 
unsigned long getNumOrderingConnections () const
 
FrameLib_BlockgetOrderingConnection (unsigned long idx) const
 
unsigned long getOrderingConnectionIdx (unsigned long idx) const
 
bool isOrderingConnection (FrameLib_Block *object) const
 
unsigned long getNumOutputDependencies () const
 
FrameLib_BlockgetOutputDependency (unsigned long idx) const
 
- Public Member Functions inherited from FrameLib_Queueable< FrameLib_Block >
 FrameLib_Queueable ()
 

Additional Inherited Members

- Public Types inherited from FrameLib_Object< FrameLib_Block >
typedef FrameLib_Queueable< FrameLib_Block >::Queue Queue
 
- Static Public Member Functions inherited from FrameLib_Object< FrameLib_Block >
static bool handlesAudio ()
 
- Protected Member Functions inherited from FrameLib_Object< FrameLib_Block >
void setIO (unsigned long nIns, unsigned long nOuts, unsigned long nAudioChans=0)
 
void enableOrderingConnections ()
 
U * alloc (unsigned long N)
 
void dealloc (U *&ptr)
 
void clearAllocator ()
 
FrameLib_LocalAllocator::StorageregisterStorage (const char *name)
 
void releaseStorage (FrameLib_LocalAllocator::Storage *&storage)
 
- Static Protected Member Functions inherited from FrameLib_Object< FrameLib_Block >
static const char * formatInfo (const char *verboseStr, const char *briefStr, bool verbose)
 
static std::string formatInfo (const char *verboseStr, const char *briefStr, unsigned long idx, bool verbose)
 
static std::string formatInfo (const char *verboseStr, const char *briefStr, const char *replaceStr, bool verbose)
 
static std::string numberedString (const char *str, unsigned long idx)
 

Constructor & Destructor Documentation

◆ FrameLib_Block()

FrameLib_Block::FrameLib_Block ( ObjectType  type,
FrameLib_Context  context,
void *  owner 
)
inline

◆ ~FrameLib_Block()

virtual FrameLib_Block::~FrameLib_Block ( )
inlinevirtual

Member Function Documentation

◆ getInputObject()

virtual class FrameLib_DSP* FrameLib_Block::getInputObject ( unsigned long  blockIdx,
unsigned long  idx 
)
pure virtual

Implemented in FrameLib_DSP.

◆ getInputObjectIdx()

virtual unsigned long FrameLib_Block::getInputObjectIdx ( unsigned long  blockIdx,
unsigned long  idx 
)
pure virtual

Implemented in FrameLib_DSP.

◆ getNumInputObjects()

virtual unsigned long FrameLib_Block::getNumInputObjects ( unsigned long  blockIdx)
pure virtual

Implemented in FrameLib_DSP.

◆ getNumOrderingConnectionObjects()

virtual unsigned long FrameLib_Block::getNumOrderingConnectionObjects ( )
pure virtual

Implemented in FrameLib_DSP.

◆ getOrderingConnectionObject()

virtual class FrameLib_DSP* FrameLib_Block::getOrderingConnectionObject ( unsigned long  idx)
pure virtual

Implemented in FrameLib_DSP.

◆ getOutputObject()

virtual class FrameLib_DSP* FrameLib_Block::getOutputObject ( unsigned long  blockIdx)
pure virtual

Implemented in FrameLib_DSP.

◆ getOutputObjectIdx()

virtual unsigned long FrameLib_Block::getOutputObjectIdx ( unsigned long  blockIdx)
pure virtual

Implemented in FrameLib_DSP.

◆ setChannel()

virtual void FrameLib_Block::setChannel ( unsigned long  chan)
inlinevirtual

The documentation for this class was generated from the following file: